Skip to content

[DOC] Fix dead links in README, user guide and contributing guide - #928

Open
markksantos wants to merge 2 commits into
PythonOT:masterfrom
markksantos:fix-dead-doc-links
Open

markksantos wants to merge 2 commits into
PythonOT:masterfrom
markksantos:fix-dead-doc-links

Conversation

@markksantos

Copy link
Copy Markdown

Types of changes

  • Documentation (dead link fixes, no code changes)

Motivation and context / Related issue

Several links in the docs return 404 or have moved:

  • README: three example gallery links (the pages are now plot_unbalanced_OT, plot_UOT_sliced and plot_dmmot) and reference [39], whose CiteSeerX download link is gone; it now points to the arXiv version (1412.7480).
  • User guide: the same reference [39], and Issue fail when using "pip install POT" #59, which still pointed at the old rflamary/POT repository.
  • CONTRIBUTING: the scikit-learn platform-specific build instructions and the Git documentation page, which both moved.

How has this been tested (if it applies)

Each old URL was checked to return 404 (or redirect to a dead page) and each replacement to return 200 with the expected content. No code changed.

PR checklist

  • I have read the CONTRIBUTING document.
  • The documentation is up-to-date with the changes I made (check build artifacts).
  • All tests passed, and additional code has been covered with new tests. (docs only)
  • I have added the PR and Issue fix to the RELEASES.md file.

I also added myself to CONTRIBUTORS.md; happy to drop that line if you'd rather not list docs-only fixes.

I drafted this with help from an AI assistant.

- README: three example gallery links (plot_unbalanced_OT, plot_UOT_sliced,
  plot_dmmot) and reference [39], whose CiteSeerX URL is gone (now arXiv 1412.7480)
- user guide: reference [39] and Issue PythonOT#59 (repo moved to PythonOT/POT)
- CONTRIBUTING: scikit-learn build instructions and Git documentation URLs

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant